7.2 编辑外部用户角色

基本信息

Path: /api/v2/externalUserRole/update

Method: POST

接口描述:

  1. 编辑外部用户角色

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

  1. 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
  2. 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户与角色”(原“用户管理”)页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取ID
  3. 本地新建的角色才能关联组织架构
  4. 需要关联"适用对象"->"组织架构"时,使用 groupNameList 可能导致关联到多个同名组织架构,后续将不再维护此参数,建议使用 groupFullPathList 作为替代
  5. 根据角色名、用户目录ID或用户目录名称编辑角色时,不支持修改角色名;根据角色ID、用户目录ID或用户目录名称编辑角色时且为自定义用户目录时,支持修改角色名。

根据角色名、用户目录ID或用户目录名称编辑角色:

名称 类型 是否必须 默认值 备注 其他信息
name string 必须 角色名
userDirectoryId string 与userDirectoryName二选一 所属用户目录ID userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
userDirectoryName string 与userDirectoryId二选一 所属用户目录名称 userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
description string 非必须 描述
userIdEditWay string 非必须 'set' 用户编辑方式,'set'重置,'append'追加,'delete'删除
userIdList string[] 非必须 用户ID列表 userIdList与userNameList只传一个即可,都传时以userIdList为准
userNameList string[] 非必须 用户名列表 userIdList与userNameList只传一个即可,都传时以userIdList为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表 resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准
resourceGroupNameList string[] 非必须 应用分类名列表 resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表 resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准
resourceNameList string[] 非必须 应用名列表 resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准
groupIdEditWay string 非必须 'set' 组织架构编辑方式,'set'重置,'append'追加,'delete'删除
groupIdList string[] 非必须 适用对象-组织架构ID列表 与groupNameList、groupFullPathList只传一个即可,传多个参数时优先级为:groupIdList > groupFullPathList > groupNameList
groupFullPathList string[] 非必须 适用对象-组织架构全路径列表,如:["/a/b", "/a/c"] 与groupIdList、groupNameList只传一个即可
groupNameList string[] 非必须 (该字段不再维护)适用对象-组织架构名列表,如:["b", "c"] 与groupIdList、groupFullPathList只传一个即可

根据角色ID、用户目录ID或用户目录名称编辑角色:

这种方式下,角色名称可以编辑。

名称 类型 是否必须 默认值 备注 其他信息
id string 必须 角色ID
name string 非必须 角色名
userDirectoryId string 与userDirectoryName二选一 所属用户目录ID userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
userDirectoryName string 与userDirectoryId二选一 所属用户目录名称 userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
name string 非必须 角色名
description string 非必须 描述
userIdEditWay string 非必须 'set' 用户编辑方式,'set'重置,'append'追加,'delete'删除
userIdList string[] 非必须 用户ID列表 userIdList与userNameList只传一个即可,都传时以userIdList为准
userNameList string[] 非必须 用户名列表 userIdList与userNameList只传一个即可,都传时以userIdList为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表 resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准
resourceGroupNameList string[] 非必须 应用分类名列表 resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表 resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准
resourceNameList string[] 非必须 应用名列表 resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准
groupIdEditWay string 非必须 'set' 组织架构编辑方式,'set'重置,'append'追加,'delete'删除
groupIdList string[] 非必须 适用对象-组织架构ID列表 与groupNameList、groupFullPathList只传一个即可,传多个参数时优先级为:groupIdList > groupFullPathList > groupNameList
groupFullPathList string[] 非必须 适用对象-组织架构全路径列表,如:["/a/b", "/a/c"] 与groupIdList、groupNameList只传一个即可
groupNameList string[] 非必须 (不再维护)适用对象-组织架构名列表,如:["b", "c"] 与groupIdList、groupFullPathList只传一个即可

请求示例

{
    "userIdEditWay": "set",
    "resourceIdEditWay": "set",
    "resourceGroupIdEditWay": "set",
    "id": "5687d130-eea8-11eb-9b6a-9f8657632b78",
    "userDirectoryName": "LDAP用户目录",
    "name": "外部用户角色1",
    "description": "",
    "userNameList": [
        "张三"
    ],
    "groupNameList": [
        "一组"
    ],
    "resourceGroupNameList": [
        "隧道应用组",
    ],
    "resourceNameList": [
        "隧道应用A"
    ]
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示错误,具体含义请参考错误码定义
data object 必须 返回内容
msg string 必须 描述信息  

返回示例

{
    "code": 0,
    "data": {},
    "msg": "请求成功",
    "traceId": "0321d1efe3801000"
}

错误信息

错误提示 错误码
参数检查出错 10000001
用户目录不存在 77200001
部分角色数据已经删除,请重新选择 10000000
角色不存在或已被删除 10000000
外部导入角色不允许编辑 77200004
角色名称(%s)已存在 77200005
用户目录不允许被编辑 77200004
服务器内部错误 10000000
外部组织架构不存在 77200001
ExternalUser不存在 77200004
Resource不存在 77200004
ResourceGroup不存在 77200004
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-09-05 14:20

results matching ""

    No results matching ""